Interface NFExporterManager

All Superinterfaces:
IPCObject
All Known Implementing Classes:
NFExporterManagerImpl

public interface NFExporterManager extends IPCObject
Information provided by the PKI file:

    \class NFExporterManager
    
    \brief NFExporterManager manages different NetFlow exporters configured on routers.
    
    \example network().getDevice("Router0").getNetflowExporterManager()
    
Author:
Auto-generated
  • Method Details

    • createNFExporter

      NFExporter createNFExporter(String exporterName)
      Information provided by the PKI file:
      
          \brief Creates a NetFlow exporter with the specified name.
          
          \param exporterName, the name for the NetFlow exporter.
          
          \return NFExporter, the NFExporter object of the created NetFlow exporter.
          
              
      Parameters:
      exporterName - Takes in a parameter of exporterName
      Returns:
      NFExporter Returns a NFExporter
    • removeNFExporter

      void removeNFExporter(String exporterName)
      Information provided by the PKI file:
      
          \brief Removes the NetFlow exporter with the specified name.
          
          \param exporterName, the name of the NetFlow exporter of interest.
          
              
      Parameters:
      exporterName - Takes in a parameter of exporterName
    • getNFExporterAt

      NFExporter getNFExporterAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow exporter at the specified index.
          
          \param index, the index of the NetFlow exporter of interest.
          
          \return NFExporter, the NFExporter object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NFExporter Returns a NFExporter
    • getNFExporterByName

      NFExporter getNFExporterByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow exporter with the specified name.
          
          \param name, the name of the NetFlow exporter of interest.
          
          \return NFExporter, the NFExporter object with the specified name.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      NFExporter Returns a NFExporter
    • getNFExporterByIpAndPort

      NFExporter getNFExporterByIpAndPort(IPAddress ipAddr, int udpPort)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow exporter with the specified IP address and UDP port number.
          
          \param ipAddr, the IP address of the NetFlow exporter of interest.
          \param udpPort, the UDP port number of the NetFlow exporter of interest.
          
          \return NFExporter, the NFExporter object with the specified name.
          
              
      Parameters:
      ipAddr - Takes in a parameter of ipAddr
      udpPort - Takes in a parameter of udpPort
      Returns:
      NFExporter Returns a NFExporter
    • removeNFExporterAt

      void removeNFExporterAt(int index)
      Information provided by the PKI file:
      
          \brief Removes the NetFlow exporter at the specified index.
          
          \param index, the index of the NetFlow exporter of interest.
          
              
      Parameters:
      index - Takes in a parameter of index
    • getNFExporterCount

      int getNFExporterCount()
      Information provided by the PKI file:
      
          \brief Returns the number of NetFlow exporters.
          
          \return int, the number of NetFlow exporters.
          
              
      Returns:
      int Returns a int